Get deal documents.

1. Tổng quan

• Action URL: /api/v1/deals/documments
• Đặc tả chi tiết: Swagger Link (opens new window)
• Tính năng này cho phép trả về danh sách tài liệu (documents) của Opportunity.
• Chỉ áp dụng cho tài khoản Agency có quyền truy cập hợp lệ và cung cấp đúng thông tin xác thực trong header (token, password, account).

---

2. Hướng dẫn

• Bước 1: Xây dựng request với đầy đủ header và body
• Bước 2: Gửi request POST tới Action URL.
• Bước 3: Nhận về response chứa danh sách invoices.

---

3. Request

3.1 Ví dụ

{
  "dealId": "6898de48c1b560cbf",
  "primaryFilter": "",
  "select": [
    "createdAt",
    "fileId",
    "fileName",
    "name"
  ],
  "maxSize": 5,
  "offset": 0,
  "orderBy": "createdAt",
  "order": "desc"
}

3.2 Cấu trúc dữ liệu Resquest

Thuộc tính	Bắt buộc	Kiểu dữ liệu	Mô tả	Ví dụ
dealId	Có	String	Mã định danh của deal/opportunity cần lấy invoices
primaryFilter	Không	String	Lọc dữ liệu theo điều kiện (nếu có)
select	Không	Array	Các trường cần lấy từ document
maxSize	Không	Number	Giới hạn số bản ghi trả về
offset	Không	Number	Vị trí bắt đầu lấy dữ liệu (phân trang)
orderBy	Không	String	Trường để sắp xếp kết quả
order	Không	String	Thứ tự sắp xếp: asc hoặc desc

4. Response

4.1 Ví dụ

{
  "StatusCode": 200,
  "Timestamp": "2:52:27 AM",
  "Path": "/api/v1/deals/documents",
  "Message": "Lấy documents thành công",
  "Data": {
    "total": 1,
    "list": [
      {
        "id": "67af80bff2d56f43c",
        "name": "Tra cứu giá vé nhanh",
        "createdAt": "2025-02-14 17:43:27",
        "fileId": "67af80b437bc7aafc",
        "fileName": "Tra cuu nhanh Amadeus.pdf",
        "createdById": "676cc0521107ef6ca",
        "assignedUserId": null
      }
    ]
  },
  "Errors": null,
  "RequestId": "req_1760583147265_2ongkgv0c",
  "TotalDuration": 443
}

4.2 Bảng mô tả trường (Response)

Thuộc tính	Bắt buộc	Kiểu dữ liệu	Mô tả	Ví dụ
StatusCode	Có	String	Tình trạng tạo sub
Timestamp	Có	String	Thời gian xử lý request
Path	Có	String
Message	Có	String	Thông báo kết quả
Errors	Không	String	Thông tin lỗi nếu có
RequestId	Có	String	Mã định danh request
TotalDuration	Có	string	Thời gian xử lý (ms)
id	Có	String	ID của tài liệu trong hệ thống
name	Có	String	Tên hiển thị của tài liệu
createdAt	Có	Datetime	Thời điểm tạo tài liệu
fileId	Có	String	ID của file trong hệ thống lưu trữ
fileName	Có	String	Tên thực tế của file đã tải lên
createdById	Có	String	ID của người tạo tài liệu
assignedUserId	Không	String	ID người được gán (nếu có)

Bảng mô tả mã tình trạng tạo sub

Mã	Ý nghĩa
200	Thành công
400	Dữ liệu không hợp lệ
401	Không có quyền tạo sub
404	DealId không tồn tại trong hệ thống
500	Lỗi từ phía server